IviFgen Get Sparse Marker Name [SM] VI

IviFgenSparseMarker [SM] Capability Group

This VI returns the repeated capability identifier for the data marker that corresponds to the one-based index that you specify. If the value that you pass for the Marker Index control is less than one or greater than the value of the data marker count, the VI returns an empty string in the Marker Name control and returns an error.

IviFgen Get Sparse Marker Name [SM].vi

	instrument handle The instrument handle that you obtain from the IviFgen Initialize or IviFgen Initialize With Options VI.
	instrument handle out The instrument handle that you obtain from the IviDigitizer Initialize VI or IviDigitizer Initialize With Options VI. The handle identifies a particular instrument session. Default Value: None
	marker index (1) A one-based index that defines which marker name to return. Valid values for the Marker Index control are between one and the value of the IviFgen Sparse Marker Count [SM] property, inclusive. Default Value: 1
	marker name Returns the marker name of the sparse marker that is in the sparse marker collection at the index you specify.
	name buffer size Pass the number of bytes in the string that you specify for the Marker Name control. If the marker name, including the terminating NUL byte, contains more bytes than you indicate in this parameter, the VI copies Name Buffer Size - 1 bytes into the buffer, places an ASCII NUL byte at the end of the buffer, and returns the buffer size you must pass to get the entire value. For example, if the value is "123456" and the Name Buffer Size is 4, the VI places "123" into the buffer and returns 7. If you pass a negative number, the VI copies the value to the buffer regardless of the number of bytes in the value. If you pass 0, you can pass VI_NULL for the Marker Name buffer control. Default Value: None
	error in (no error) The error in cluster can accept error information wired from VIs previously called. Use this information to decide if any functionality should be bypassed in the event of errors from other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.
	error out The error out cluster passes error or warning information out of a VI to be used by other VIs. The pop-up option Explain Error (or Explain Warning) gives more information about the error displayed.